home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / e / ddmoduls.lha / dd_Modules / dd_gui / dd_onlinehelp.doc < prev    next >
Text File  |  1995-05-04  |  3KB  |  116 lines
  1. dd_blackboxes/dd_onlinehelp
  2.  
  3. NAME
  4.  
  5.   dd_onlinehelp.m -- module for context sensitive online help
  6.  
  7. AUTHOR
  8.  
  9.   Leon Woestenberg of Digital Disturbance (Email: leon@stack.urc.tue.nl)
  10.  
  11. REQUIREMENTS
  12.  
  13.   Requires the amigaguide.library v34 (or later) to be installed.
  14.  
  15. DESCRIPTION
  16.  
  17.   The dd_onlinehelp module is an easy way to add online help features to
  18.   your window applications programs, in a somewhat object oriented way.
  19.   It is context sensitive; a help item is shown that corresponds to the
  20.   current application context, i.e. a window, a gadget, a menu item etc.
  21.  
  22. FEATURES
  23.  
  24.   A base layer to add online help features to your applications, a thing
  25.   that should be supported by a good application. Context sensitivity
  26.   fully supported.
  27.  
  28. METHODS
  29.  
  30.   new -- construct a class instance
  31.  
  32.     SYNOPSIS
  33.       instance.new(guidefile,arexxname,basename,contextlist)
  34.  
  35.     INPUTS
  36.       guidefile (PTR TO CHAR) -- name of AmigaGuide database file.
  37.       arexxname (PTR TO CHAR) -- name of AmigaGuide client's ARexx port.
  38.       basename (PTR TO CHAR) -- bare name of the calling application.
  39.       contextlist (PTR TO LONG) -- NIL terminated list with strings, each
  40.         corresponding with the node names in the amigaguide.
  41.  
  42.     RESULT
  43.        Returns FALSE if the construction failed.
  44.  
  45.   setcontext -- set current user context
  46.  
  47.     SYNOPSIS
  48.       instance.setcontext(indexnumber)
  49.  
  50.     FUNCTION
  51.       This method just sets the current user context. Advised usage is
  52.       to update this every time a user enters a new context, i.e.
  53.       activates a window, points at a gadget, pulls down a menu etc.
  54.  
  55.     INPUTS
  56.  
  57.       indexnumber (LONG) -- The index number (0...) of the context
  58.         you want to set. The index is used to search the context list as
  59.         defined in the new() method.
  60.  
  61.     RESULT
  62.        No results.
  63.  
  64.   help -- display help on current context
  65.  
  66.     SYNOPSIS
  67.       instance.help()
  68.  
  69.     FUNCTION
  70.       This method displays help on the current user context. Advised
  71.       usage is when the user selected 'Help...' from a pulldown menu,
  72.       pressed the HELP key, or something similar.
  73.  
  74.       Note that you have to keep the context up-to-date using setcontext()
  75.       during program run, otherwise the user might get false help texts
  76.       when he or she needs it, which lead to confusion.
  77.  
  78.     RESULT
  79.        No results.
  80.  
  81.    signalmask -- returns the signal to wait for
  82.  
  83.     SYNOPSIS
  84.       instance.signalmask()
  85.  
  86.     FUNCTION
  87.       Returns the signalmask your program should Wait() for. When there
  88.       is a signal, you must call the handle() method. You may not act
  89.       on this signal yourself.
  90.  
  91.     RESULT
  92.       A 32 bit mask indicating which signal is reserved for amigaguide
  93.       communication.
  94.  
  95.    handle -- handles amigaguide messages
  96.  
  97.     SYNOPSIS
  98.       instance.handle()
  99.  
  100.     FUNCTION
  101.       Handles amigaguide messages from the amigaguide server process.
  102.  
  103.     RESULT
  104.        No results.
  105.  
  106. TODO
  107.  
  108.   - Make the interface more standard and open for feature enhancements.
  109.   - Also, I would like to know how to detect when an AmigaGuide online help
  110.   database is closed by the user. There seems to be no message for that?
  111.  
  112. SEE ALSO
  113.  
  114.   amigaguide.library, gadtools.library, exec.library/Wait()
  115.  
  116.